/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/

package com.yauthor.module.editor.design
{
	/**
	 * Config for style editor. Defines data for view configuration
	 */ 
	public interface IStyleConfig
	{
		/**
		 * Gets display name of mofidicator
		 */ 
		function get displayName():String;
		
		/**
		 * Gets property editor type
		 * If true drawn as inline editor, if false drawn on popup window
		 */ 
		function get inline():Boolean;
		
		[ArrayElementType("String")] 
		/**
		 * List of configuration property names defined for this
		 * editor instance.
		 * @return list of names (strings), if name appears more than once in
		 * configuration is listed only once in this list
		 */
		function get propertyNames():Array;
		
		[ArrayElementType("Object")]
		/**
		 * List of configuration properties and they values. In this list
		 * order of properties is kept.
		 * @return list of objects with properties:
		 * <ul>
		 * <li>name - where property name is placed
		 * <li>value - where property value is placed
		 * </ul>
		 */
		function get propertyList():Array;
		
		/**
		 * Return property value that is hold under given name. If this 
		 * property appears multiple times on config list, the first value is 
		 * returned
		 * @param name property name
		 * @return property value or null if this property doesn't exist
		 */ 
		function getPropertyValue( name:String ):String;
		
		[ArrayElementType("String")]
		/**
		 * Return list of property values that are placed under given name.
		 * All values that have this name are placed in this list in order
		 * that they appear in configuration.
		 * @param name proeprty name
		 * @return property value list or null if this property doesn't exist
		 */
		function getPropertyValues( name:String ):Array;
	}
}